//+=============================================================================
// Func: example
// Desc: An example header with a number of different parameters designed to
//         trick the reader in to breaking
// Args:                   u8*      buffer .. A buffer with the bytes
//     :             const u32      index  .. A bit-offset in to the buffer [1]
//     : volatile unsigned Length*  length .. A pointer to a length supplied in
//                                              real-time by the processor
//     :                   u32      bits   .. Bit-pattern to be written [2]
// Retn: const Foo* .. test return value
// Note: [1] Bits are numbered left-to-right from 1. EG:
//           The left-most  bit of the first  byte is bit-0
//           The right-most bit of the second byte is bit-15
//     : [2] The bit-pattern must be held in the least-significant bits of the
//           u32 'bits' field
//     : A one line note
//     : Another one line note
// Auth: Chadderz; BlueChip
//==============================================================================
//+=============================================================================
// Args:  u8*   buffer
// Args:  u8*   buffer ..s
// Auth: Chadderz; BlueChip;
//       Gary; Wilma StPish
// Retn: -none-
foo
//+=============================================================================
// Args:  -none-
// Retn: -none-
// Auth: Chadderz; BlueChip; Fred
//       Gary; Wilma

%func%
%desc%
%pram_cnt%
	%pram_pre%
	%pram_type%
	%pram_name%
	%pram_desc%
%retn%
%note_cnt%
	%note%
%auth_cnt%
	%auth%

